Run(string,List<IMasterFormsCategory>) Method

Summary

Automatically recognizes the unknown form then it processes its fields.

Syntax

C++/CLI

Java

Python

public AutoFormsRunResult Run( 
   string fileName, 
   List<IMasterFormsCategory> categories 
)

public AutoFormsRunResult run( 
   java.lang.String fileName, 
   java.util.List<IMasterFormsCategory> categories 
);

public: 
AutoFormsRunResult^ Run(  
   String^ fileName, 
   List<IMasterFormsCategory^>^ categories 
)

def Run(self,fileName,categories):

Parameters

fileName
A System.String containing the name of the unknown form image file.

categories
List of Master Forms categories to use in comparison, pass null or empty to use all Master Forms in the repository.

Return Value

Returns the results of the recognition and processing if the form is recognized, otherwise it returns null. If the Master Form has no processing field, AutoFormsRunResult.FormFields will be null.

Remarks

This method automatically recognizes the unknown form and process its fields at the same time.

The fileName should have all form pages.

If RecognizeFirstPageOnly is true, the recognition will be performed based on the first page only, if it is false the recognition will be performed over all the form pages.

If the form is not recognized it will return null, if the Master Form of the fileName type has no field then AutoFormsRunResult.FormFields will be null.

Example

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Forms.Common; 
using Leadtools.Forms.Auto; 
using Leadtools.Document; 
using Leadtools.Ocr; 
using Leadtools.Forms.Recognition; 
using Leadtools.Forms.Processing; 
using Leadtools.Barcode; 
 
using Leadtools.Forms; 
 
public void AutoFormRunFile() 
{ 
   string root = Path.Combine(LEAD_VARS.ImagesDir, @"Forms\FormsDemo\OCR_Test"); 
   RasterCodecs codecs = new RasterCodecs(); 
   //create repository 
   DiskMasterFormsRepository repository = new DiskMasterFormsRepository(codecs, root); 
 
   using (IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.LEAD)) 
   { 
      ocrEngine.Startup(null, null, null, LEAD_VARS.OcrLEADRuntimeDir); 
      BarcodeEngine barcodeEngine = new BarcodeEngine(); 
 
      //create AutoForm Engine 
      AutoFormsEngine autoEngine = new AutoFormsEngine(repository, ocrEngine, barcodeEngine, AutoFormsRecognitionManager.Ocr | AutoFormsRecognitionManager.Default, 30, 80, true); 
 
      //recognize and process the form 
      AutoFormsRunResult result = autoEngine.Run(Path.Combine(LEAD_VARS.ImagesDir, @"Forms\Forms to be Recognized\OCR\FCC-107_OCR_Filled.tif"), null); 
      if (result == null) 
         return; 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
   public const string OcrLEADRuntimeDir = @"C:\LEADTOOLS23\Bin\Common\OcrLEADRuntime"; 
}

Requirements

Target Platforms

Reference

AutoFormsEngine Class

AutoFormsEngine Members

Overload List

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Forms.Auto Assembly

Introduction

Getting Started

Namespaces

Leadtools.Forms.Auto Namespace

Assemblies